Skip to content

Feature/extlinks #382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Feature/extlinks #382

wants to merge 2 commits into from

Conversation

StaticRocket
Copy link
Member

  • feat(extlinks): use ti-linux-kernel-binding role

    Use the new ti-linux-kernel-binding role provided through extlinks to reduce
    text and allow for quick branch changes.

    Signed-off-by: Randolph Sapp [email protected]

  • feat(extlinks): add extlinks and a suitable config

    Add the extlinks sphinx extensions and a basic JSON configuration file that we
    will load during the build. The conf.py is already pretty unwieldy so keeping
    this separate is probably a good idea.

    Signed-off-by: Randolph Sapp [email protected]

@StaticRocket
feat(extlinks): add extlinks and a suitable config
ca648ea 
Add the extlinks sphinx extensions and a basic JSON configuration file
that we will load during the build. The conf.py is already pretty
unwieldy so keeping this separate is probably a good idea.

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket
feat(extlinks): use ti-linux-kernel-binding role
f8e2624 
Use the new ti-linux-kernel-binding role provided through extlinks to
reduce text and allow for quick branch changes.

Signed-off-by: Randolph Sapp <[email protected]>
@github-actions GitHub Actions
Copy link

New warnings found with rstcheck:

source/linux/Foundational_Components_IPC_J784S4.rst:204: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC_J784S4.rst:204: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC64x.rst:161: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC64x.rst:161: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC_J722S.rst:161: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC_J722S.rst:161: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC_J7200.rst:155: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC_J7200.rst:155: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC_J742S2.rst:198: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC_J742S2.rst:198: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC62ax.rst:167: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC62ax.rst:167: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC62x.rst:161: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC62x.rst:161: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC_J721E.rst:227: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC_J721E.rst:227: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC_J721S2.rst:181: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC_J721S2.rst:181: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components_IPC62px.rst:158: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components_IPC62px.rst:158: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_sr10.rst:71: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_sr10.rst:71: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst:84: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst:84: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".
source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst:84: (INFO/1) No role entry for "ti-linux-kernel-binding" in module "docutils.parsers.rst.languages.en".
source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst:84: (ERROR/3) Unknown interpreted text role "ti-linux-kernel-binding".

@StaticRocket
Copy link
Member Author

This draft is to propose usage of extlinks as opposed to explicit links for quicker referencing and global updates to branches. It currently goes over one application of the extension: short links to device tree bindings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@praneethbajjuri praneethbajjuri praneethbajjuri approved these changes

@devarsht devarsht Awaiting requested review from devarsht

@r-vignesh r-vignesh Awaiting requested review from r-vignesh

@uditkumarti uditkumarti Awaiting requested review from uditkumarti uditkumarti is a code owner

@cshilwant cshilwant Awaiting requested review from cshilwant cshilwant will be requested when the pull request is marked ready for review cshilwant is a code owner

@aniket-l aniket-l Awaiting requested review from aniket-l aniket-l will be requested when the pull request is marked ready for review aniket-l is a code owner

@VeeruPrudhvi VeeruPrudhvi Awaiting requested review from VeeruPrudhvi VeeruPrudhvi will be requested when the pull request is marked ready for review VeeruPrudhvi is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees

@praneethbajjuri praneethbajjuri

@devarsht devarsht

@r-vignesh r-vignesh

@uditkumarti uditkumarti

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@StaticRocket @praneethbajjuri @devarsht @r-vignesh @uditkumarti